/*
 * Copyright (c) 2012, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.bmi.gwt.mi.server.events;

import org.bmi.gwt.mi.server.annotation.QueueHandler;

/**
 * This is an interface defining a queue event handler. To specify the queue
 * expression the class requires a {@link QueueHandler} annotation. If such
 * annotation will not be provided the handler will be applied to any queue.
 * 
 * @author marco.tamburelli@gmail.com
 */
public interface QueueEventHandler
{
	/**
	 * Fired when a queue matching the expression provided on the
	 * {@link QueueHandler} annotation is created.
	 * 
	 * @param event
	 */
	void onCreate(QueueEvent event);

	/**
	 * Fired when a queue matching the expression provided on the
	 * {@link QueueHandler} annotation is owned by a peer
	 * 
	 * @param event
	 */
	void onBound(QueueEvent event);

	/**
	 * Fired when a queue matching the expression provided on the
	 * {@link QueueHandler} annotation is updated (when some attribute is
	 * updated).
	 * 
	 * @param event
	 */
	void onUpdate(QueueEvent event);

	/**
	 * Fired when a queue matching the expression provided on the
	 * {@link QueueHandler} annotation is disposed.
	 * 
	 * @param event
	 */
	void onDispose(QueueEvent event);
}
